docs: Add executor readiness gating to /v1/ready endpoint#1733
Merged
Conversation
Update OpenAPI spec and API docs for the new /v1/ready query parameters that gate readiness on executor availability in distributed (scheduler) mode: min_ready_executors, min_ready_executors_percent, and verbose.
✅ Pull with Spice PassedPassing checks:
|
|
🚀 deployed to https://ca3ec5b0.spiceai-org-website.pages.dev |
lukekim
approved these changes
May 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
min_ready_executors,min_ready_executors_percent, andverbosequery parameters to the/v1/readyendpoint in the OpenAPI spec and generated API docsSource PRs
Changes
website/public/openapi.json— Added query parameters and 400 response to/v1/readyendpointwebsite/docs/api/HTTP/ready.api.mdx— Regenerated from updated spec with executor gating description and exampleswebsite/docs/api/HTTP/ready.*.json— New parameter/schema/status JSON files for the ready endpointTest plan
cd website && npm run buildpasses locally (Docusaurus throws on broken links and undefined frontmatter tags)